HPD Retrieval API
Search HPD Practitioner Request
URL: POST /api/practitionerquery/v1/{{SLUG_NAME}}
Where:
- SLUG_NAME for Practitioner can be:
- hpd-practitioner-qualification-active - Active Practitioner Only
- hpd-practitioner-qualification-active-apc-expiring-30-days - Practitioners with APC expiring in 30 days.
- hpd-practitioner-qualification-all - All Practitioners
Note: practitionerQuery is a required field - but you can pass in empty queryCriteria (just so the query engine works)
REQUEST PAYLOAD
{
"practitionerQuery": {{QUERY_OBJECT}},
"pageSize": 10,
"queryResultType": "{{RETURN_TYPE}}"
"sortBy": "{{FIELD_NAME}}",
"sortDirection": "{{SORT_DIRECTION}}"
}
SAMPLE USE CASE:
Find practitioner with CPN 95ZZHW
POST /api/practitionerQuery/hpd-practitioner-qualification-all
{
"practitionerQuery": {
"operator": "AND",
"queryGroup": [],
"queryCriteria": [
{
"name": "cpn",
"operator": "STRINGEQUALS",
"value": "95ZZHW"
}
]
},
"pageSize": 10,
"queryResultType": "JsonAttribute"
}